Fix the introspection GitHub action tests (Feb 2024)

[palisadoes]

Is your feature request related to a problem? Please describe.

1. Our introspection PR tests have been failing. This seems to be caused by code that references now deprecated Event and User task functionality.
2. Here is a recent example:
   1. https://github.com/PalisadoesFoundation/talawa-admin/actions/runs/7774376104/job/21199116216?pr=1539

Describe the solution you'd like

This issue has two parts. We have a history of this error repeating itself and it needs to be finally resolved permanently

Short Term Solution

1. Update the offending code to make the introspection tests pass
2. All existing tests must pass and must be valid tests of the code base
3. No other functionality must be affected

Long Term Solution

1. Determine what is causing the problem where the API and Admin repos are periodically out of sync and fix it.
2. We think it may be caused by this issue not being successfully resolved. You may need to coordinate with the person assigned this issue
   1. Fix our Introspection Schema check GitHub Action talawa-api#1599
3. NOTE: This may mean creating a GitHub action to automatically create issues when an API PR is merged where the schema is updated.
4. All existing tests must pass and must be valid tests of the code base
5. No other functionality must be affected

Describe alternatives you've considered

• N/A

Approach to be followed (optional)

• See above

Additional context

• @Cioppolo14 This will be good to track

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

• Student Internship Programs talawa#359

[akhilender-bongirwar]

I would like to work on this issue.

[palisadoes]

Please read the updated long term solution section

[akhilender-bongirwar]

@palisadoes Sir,

For the Short-Term Solution to the introspection PR test failure, we can revert this #1499 in talawa-admin for now. We should wait for this PR in talawa-api to be merged first. Afterward, we can merge that PR into talawa-admin.

[akhilender-bongirwar]

@palisadoes Sir, just a quick follow-up on the short-term solution proposal for the introspection PR test failure. I am still awaiting your opinion. Thank you.

[palisadoes]

We didn't realize that the two PRs were linked.

I'd prefer not to revert. Will the introspection be fixed after the API merge?

[palisadoes]

What about the line term solution?

[akhilender-bongirwar]

We didn't realize that the two PRs were linked.

I'd prefer not to revert. Will the introspection be fixed after the API merge?

Yes, sir the introspection will be fixed after the API merge.

[akhilender-bongirwar]

What about the line term solution?

Sir, these are few points I would like to address

Observations

1. The talawa-api schema is ahead of the admin schema, which has not caused any issues in the regular functioning of the talawa-admin portal.

2. Attributes required for new features in the admin schema have been sourced from talawa-api.

3. The GraphQL introspection failure typically occurs when new attributes are declared in the admin schema but are not defined in the API schema. These attributes often lack defined logic, resulting in potential failures for associated actions/functions.

4. We already have a dedicated Graphql-Inspector GitHub Action to handle the scenario mentioned above.

Fix

• When adding a new attribute in admin schema for a fix or feature, it's crucial to declare that attribute in the API schema first and then use it in the admin. This approach prevents introspection errors and ensures the smooth operation of our application without errors.

Remarks

• Sir, IMO, it is better we have the API schema ahead of the admin schema. This ensures that development is not halted in the API, and it allows us to create new features in admin using those attributes.
• This practice does not pose any issues for the development server.
• We should only be cautious about preventing errors when new attributes added to the admin schema are not declared in the API schema. Until this error is addressed, everything else will function correctly.

[akhilender-bongirwar]

What about the line term solution?

Sir, these are few points I would like to address

Observations

1. The `talawa-api schema` is ahead of the `admin schema`, which has not caused any issues in the regular functioning of the `talawa-admin` portal.

2. Attributes required for new features in the admin `schema` have been sourced from `talawa-api`.

3. The `GraphQL introspection` failure typically occurs when new attributes are declared in the admin schema but are not defined in the API schema. These attributes often lack defined logic, resulting in potential failures for associated actions/functions.

4. We already have a dedicated `Graphql-Inspector` GitHub Action to handle the scenario mentioned above.

Fix

* When adding a new attribute in `admin schema` for a fix or feature, it's crucial to declare that attribute in the `API schema` first and then use it in the admin. This approach prevents introspection errors and ensures the smooth operation of our application without errors.

Remarks

* Sir, IMO, it is better we have the `API schema` ahead of the `admin schema`. This ensures that development is not halted in the API, and it allows us to create new features in admin using those attributes.

* This practice does not pose any issues for the development server.

* We should only be cautious about preventing errors when new attributes added to the admin schema are not declared in the API schema. Until this error is addressed, everything else will function correctly.

@palisadoes, sir, I would like to know your thoughts on this.

[palisadoes]

We should only be cautious about preventing errors when new attributes added to the admin
schema are not declared in the API schema. Until this error is addressed, everything else will
function correctly.

How could we adjust our introspection test to fail in this case but not when the API is ahead of Admin?

[akhilender-bongirwar]

@palisadoes sir,

• The current Graphql-Inspector Github action is already performing the same task. This is evident from the fact that the action was successful until the Corrected placeholder text, added missing inputs(video,images) and their tests to edit post feature present in Admin role.  #1483 was merged actions. However, it started failing right after the merge of this PR.
• This workflow correctly identified the cause, stating:

[log] - Field 'id' is not defined by type 'UpdateUserInput'.
 - Field 'applangcode' is not defined by type 'UpdateUserInput.'

• These were the exact fields added to the schema which were not defined in the schema in the api.
• It is evident that from this PR merge, the workflow is not affected by the API being ahead of the admin.

[palisadoes]

OK, thanks

[palisadoes]

1. Based on this discussion, it sounds like we really have an issue.
2. I'll close the issue