feat(api): refactor Query.project + expose via public API (#6654)

Author: n1ru4l

integration-tests/testkit/flow.ts

@@ -607,7 +607,7 @@ export function readProjectInfo(
   return execute({
     document: graphql(`
       query readProjectInfo($selector: ProjectSelectorInput!) {
-        project(selector: $selector) {
+        project(reference: { bySelector: $selector }) {
           id
           slug
         }

integration-tests/tests/api/policy/policy-access.spec.ts

@@ -8,7 +8,7 @@ describe('Policy Access', () => {
   describe('Project', () => {
     const query = graphql(`
       query ProjectSchemaPolicyAccess($selector: ProjectSelectorInput!) {
-        project(selector: $selector) {
+        project(reference: { bySelector: $selector }) {
           schemaPolicy {
             id
           }

packages/services/api/src/modules/project/module.graphql.ts

@@ -2,7 +2,7 @@ import { gql } from 'graphql-modules';
 
 export default gql`
   extend type Query {
-    project(selector: ProjectSelectorInput!): Project
+    project(reference: ProjectReferenceInput! @tag(name: "public")): Project @tag(name: "public")
     projects(selector: OrganizationSelectorInput!): ProjectConnection!
   }
 
@@ -66,8 +66,8 @@ export default gql`
   }
 
   input ProjectSelectorInput {
-    organizationSlug: String!
-    projectSlug: String!
+    organizationSlug: String! @tag(name: "public")
+    projectSlug: String! @tag(name: "public")
   }
 
   type ProjectSelector {
@@ -87,9 +87,14 @@ export default gql`
     projectBySlug(projectSlug: String!): Project
   }
 
+  input ProjectReferenceInput @oneOf {
+    byId: ID @tag(name: "public")
+    bySelector: ProjectSelectorInput @tag(name: "public")
+  }
+
   type Project {
-    id: ID!
-    slug: String!
+    id: ID! @tag(name: "public")
+    slug: String! @tag(name: "public")
     cleanId: ID! @deprecated(reason: "Use the 'slug' field instead.")
     name: String! @deprecated(reason: "Use the 'slug' field instead.")
     type: ProjectType!

packages/services/api/src/modules/project/providers/project-manager.ts

@@ -1,7 +1,9 @@
 import { Injectable, Scope } from 'graphql-modules';
+import type { ProjectReferenceInput } from '../../../__generated__/types';
 import type { Organization, Project, ProjectType } from '../../../shared/entities';
 import { AuditLogRecorder } from '../../audit-logs/providers/audit-log-recorder';
 import { Session } from '../../auth/lib/authz';
+import { IdTranslator } from '../../shared/providers/id-translator';
 import { Logger } from '../../shared/providers/logger';
 import { OrganizationSelector, ProjectSelector, Storage } from '../../shared/providers/storage';
 import { TokenStorage } from '../../token/providers/token-storage';
@@ -25,6 +27,7 @@ export class ProjectManager {
     private session: Session,
     private tokenStorage: TokenStorage,
     private auditLog: AuditLogRecorder,
+    private idTranslator: IdTranslator,
   ) {
     this.logger = logger.child({ source: 'ProjectManager' });
   }
@@ -124,6 +127,16 @@ export class ProjectManager {
     return this.storage.getProject(selector);
   }
 
+  async getProjectByRereference(reference: ProjectReferenceInput): Promise<Project | null> {
+    const selector = await this.idTranslator.resolveProjectReference({ reference });
+
+    if (selector === null) {
+      this.session.raise('project:describe');
+    }
+
+    return await this.getProject(selector);
+  }
+
   async getProjectBySlugForOrganization(
     organization: Organization,
     projectSlug: string,

packages/services/api/src/modules/project/resolvers/Query/project.ts

@@ -1,19 +1,10 @@
-import { IdTranslator } from '../../../shared/providers/id-translator';
 import { ProjectManager } from '../../providers/project-manager';
 import type { QueryResolvers } from './../../../../__generated__/types';
 
 export const project: NonNullable<QueryResolvers['project']> = async (
   _,
-  { selector },
+  { reference },
   { injector },
 ) => {
-  const translator = injector.get(IdTranslator);
-  const [organization, project] = await Promise.all([
-    translator.translateOrganizationId(selector),
-    translator.translateProjectId(selector),
-  ]);
-  return injector.get(ProjectManager).getProject({
-    projectId: project,
-    organizationId: organization,
-  });
+  return await injector.get(ProjectManager).getProjectByRereference(reference);
 };

packages/services/api/src/modules/shared/providers/id-translator.ts

@@ -218,6 +218,64 @@ export class IdTranslator {
 
     return selector;
   }
+
+  async resolveProjectReference(args: {
+    reference: GraphQLSchema.ProjectReferenceInput;
+  }): Promise<{ organizationId: string; projectId: string } | null> {
+    this.logger.debug('Resolve project reference. (reference=%o)', args.reference);
+
+    let selector: {
+      organizationId: string;
+      projectId: string;
+    };
+
+    if (args.reference?.bySelector) {
+      try {
+        const [organizationId, projectId] = await Promise.all([
+          this.translateOrganizationId(args.reference.bySelector),
+          this.translateProjectId(args.reference.bySelector),
+        ]);
+        this.logger.debug(
+          'Project selector resolved. (organization=%s, project=%s)',
+          organizationId,
+          projectId,
+        );
+
+        selector = {
+          organizationId,
+          projectId,
+        };
+      } catch (error: unknown) {
+        this.logger.debug(String(error));
+        this.logger.debug('Failed to resolve input slug to ids (slug=%o)', args.reference);
+        return null;
+      }
+    } else {
+      if (!isUUID(args.reference.byId)) {
+        this.logger.debug('Invalid uuid provided. (targetId=%s)', args.reference.byId);
+        return null;
+      }
+
+      const project = await this.storage.getProjectById(args.reference.byId);
+      if (!project) {
+        this.logger.debug('Project not found. (targetId=%s)', args.reference.byId);
+        return null;
+      }
+
+      selector = {
+        organizationId: project.orgId,
+        projectId: project.id,
+      };
+    }
+
+    this.logger.debug(
+      'Project selector resolved. (organization=%s, project=%s)',
+      selector.organizationId,
+      selector.projectId,
+    );
+
+    return selector;
+  }
 }
 
 function filterSelector(

packages/services/api/src/modules/shared/providers/storage.ts

@@ -205,6 +205,8 @@ export interface Storage {
 
   getProjects(_: OrganizationSelector): Promise<Project[] | never>;
 
+  getProjectById(projectId: string): Promise<Project | null>;
+
   findProjectsByIds(args: { projectIds: Array<string> }): Promise<Map<string, Project>>;
 
   createProject(_: Pick<Project, 'type'> & { slug: string } & OrganizationSelector): Promise<

packages/services/storage/src/index.ts

@@ -1430,6 +1430,11 @@ export async function createStorage(
         });
       },
     ),
+    getProjectById(projectId) {
+      return this.findProjectsByIds({ projectIds: [projectId] }).then(
+        map => map.get(projectId) ?? null,
+      );
+    },
     async updateProjectSlug({ slug, organizationId: organization, projectId: project }) {
       return pool.transaction(async t => {
         const projectSlugExists = await t.exists(

packages/web/app/src/components/project/settings/external-composition.tsx

@@ -307,7 +307,7 @@ const ExternalComposition_DisableMutation = graphql(`
 
 const ExternalComposition_ProjectConfigurationQuery = graphql(`
   query ExternalComposition_ProjectConfigurationQuery($selector: ProjectSelectorInput!) {
-    project(selector: $selector) {
+    project(reference: { bySelector: $selector }) {
       id
       slug
       isNativeFederationEnabled

packages/web/app/src/components/project/settings/native-composition.tsx

@@ -117,7 +117,7 @@ const NativeCompositionSettings_ProjectFragment = graphql(`
 
 const NativeCompositionSettings_ProjectQuery = graphql(`
   query NativeCompositionSettings_ProjectQuery($selector: ProjectSelectorInput!) {
-    project(selector: $selector) {
+    project(reference: { bySelector: $selector }) {
       id
       nativeFederationCompatibility
       experimental_nativeCompositionPerTarget