[server] implement organization API

Author: svenefftinge

components/gitpod-protocol/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "mochaExplorer.files": [
+        "dist/**/*.spec.js",
+        "dist/**/*.spec.db.js"
+    ],
+    "mochaExplorer.require": [
+        "source-map-support/register",
+        "reflect-metadata/Reflect"
+    ],
+    "mochaExplorer.watch": [
+        "dist/**/*.spec.js",
+        "dist/**/*.spec.db.js"
+    ],
+    "mochaExplorer.exit": true,
+    "mochaExplorer.timeout": 60000
+}

components/gitpod-protocol/BUILD.yaml

@@ -20,6 +20,9 @@ packages:
       packaging: library
       yarnLock: ${coreYarnLockBase}/yarn.lock
       tsconfig: tsconfig.json
+      commands:
+        # leeway executes the build and test step in the wrong order, so we need to call a special script that builds before testing
+        test: ["yarn", "test:leeway"]
   - name: gitpod-schema
     type: generic
     srcs:

components/gitpod-protocol/package.json

@@ -41,8 +41,9 @@
         "build": "yarn lint && tsc",
         "lint": "yarn eslint src/*.ts src/**/*.ts",
         "lint:fix": "yarn eslint src/*.ts src/**/*.ts --fix",
-        "test": "mocha './**/*.spec.ts' --exclude './node_modules/**'",
-        "test-debug": "mocha --inspect-brk './**/*.spec.ts' --exclude './node_modules/**' --exit",
+        "test": "mocha './**/*.spec.js' --exclude './node_modules/**' --exit",
+        "test:leeway": "yarn build && yarn test",
+        "test-debug": "mocha --inspect-brk './**/*.spec.js' --exclude './node_modules/**' --exit",
         "watch": "leeway exec --package .:lib --transitive-dependencies --filter-type yarn --components --parallel -- tsc -w --preserveWatchOutput"
     },
     "mocha": {

components/gitpod-protocol/src/public-api-converter.spec.ts

@@ -20,6 +20,11 @@ import {
     WorkspacePort_Protocol,
     WorkspaceStatus,
 } from "@gitpod/public-api/lib/gitpod/experimental/v2/workspace_pb";
+import {
+    Organization,
+    OrganizationMember,
+    OrganizationRole,
+} from "@gitpod/public-api/lib/gitpod/experimental/v2/organization_pb";
 import { ApplicationError, ErrorCode, ErrorCodes } from "./messaging/error";
 import {
     CommitContext,
@@ -39,6 +44,7 @@ import {
 } from "./workspace-instance";
 import { ContextURL } from "./context-url";
 import { TrustedValue } from "./util/scrubbing";
+import { Organization as ProtocolOrganization, OrgMemberInfo, OrgMemberRole } from "./teams-projects-protocol";
 
 const applicationErrorCode = "application-error-code";
 const applicationErrorData = "application-error-data";
@@ -314,4 +320,46 @@ export class PublicAPIConverter {
         }
         return WorkspacePhase_Phase.UNSPECIFIED;
     }
+
+    toOrganization(org: ProtocolOrganization): Organization {
+        const result = new Organization();
+        result.id = org.id;
+        result.name = org.name;
+        result.creationTime = Timestamp.fromDate(new Date(org.creationTime));
+        return result;
+    }
+
+    toOrganizationMember(member: OrgMemberInfo): OrganizationMember {
+        const result = new OrganizationMember();
+        result.userId = member.userId;
+        result.fullName = member.fullName;
+        result.primaryEmail = member.primaryEmail;
+        result.avatarUrl = member.avatarUrl;
+        result.role = this.toOrgMemberRole(member.role);
+        result.memberSince = Timestamp.fromDate(new Date(member.memberSince));
+        result.ownedByOrganization = member.ownedByOrganization;
+        return result;
+    }
+
+    toOrgMemberRole(role: OrgMemberRole): OrganizationRole {
+        switch (role) {
+            case "owner":
+                return OrganizationRole.OWNER;
+            case "member":
+                return OrganizationRole.MEMBER;
+            default:
+                throw new Error(`unknown org member role ${role}`);
+        }
+    }
+
+    fromOrgMemberRole(role: OrganizationRole): OrgMemberRole {
+        switch (role) {
+            case OrganizationRole.OWNER:
+                return "owner";
+            case OrganizationRole.MEMBER:
+                return "member";
+            default:
+                throw new Error(`unknown org member role ${role}`);
+        }
+    }
 }

components/gitpod-protocol/src/public-api-converter.ts

@@ -0,0 +1,208 @@
+syntax = "proto3";
+
+package gitpod.experimental.v2;
+
+import "google/protobuf/timestamp.proto";
+import "gitpod/experimental/v2/pagination.proto";
+
+option go_package = "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v2";
+
+
+message Organization {
+    string id = 1;
+    string name = 2;
+    google.protobuf.Timestamp creation_time = 3;
+}
+
+message OrganizationMember {
+    string user_id = 1;
+    OrganizationRole role = 2;
+    google.protobuf.Timestamp member_since = 3;
+    optional string avatar_url = 4;
+    optional string full_name = 5;
+    optional string primary_email = 6;
+    bool owned_by_organization = 7;
+}
+
+enum OrganizationRole {
+    ORGANIZATION_ROLE_UNSPECIFIED = 0;
+    ORGANIZATION_ROLE_OWNER = 1;
+    ORGANIZATION_ROLE_MEMBER = 2;
+}
+
+message OrganizationSettings {
+    bool workspace_sharing_disabled = 1;
+    optional string default_workspace_image = 2;
+}
+
+service OrganizationService {
+    // CreateOrganization creates a new Organization.
+    rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse) {};
+
+    // GetOrganization retrieves a single Organization.
+    rpc GetOrganization(GetOrganizationRequest) returns (GetOrganizationResponse) {}
+
+    // UpdateOrganization updates the properties of an Organization.
+    rpc UpdateOrganization(UpdateOrganizationRequest) returns (UpdateOrganizationResponse) {};
+
+    // ListOrganizations lists all organization the caller has access to.
+    rpc ListOrganizations(ListOrganizationsRequest) returns (ListOrganizationsResponse) {};
+
+    // DeleteOrganization deletes the specified organization.
+    rpc DeleteOrganization(DeleteOrganizationRequest) returns (DeleteOrganizationResponse) {};
+
+    // GetOrganizationInvitation retrieves the invitation for a Organization.
+    rpc GetOrganizationInvitation(GetOrganizationInvitationRequest) returns (GetOrganizationInvitationResponse) {};
+
+    // JoinOrganization makes the caller a OrganizationMember of the Organization.
+    rpc JoinOrganization(JoinOrganizationRequest) returns (JoinOrganizationResponse) {};
+
+    // ResetOrganizationInvitation resets the invitation_id for a Organization.
+    rpc ResetOrganizationInvitation(ResetOrganizationInvitationRequest) returns (ResetOrganizationInvitationResponse) {};
+
+    // ListOrganizationMembers lists the members of a Organization.
+    rpc ListOrganizationMembers(ListOrganizationMembersRequest) returns (ListOrganizationMembersResponse) {};
+
+    // UpdateOrganizationMember updates organization membership properties.
+    rpc UpdateOrganizationMember(UpdateOrganizationMemberRequest) returns (UpdateOrganizationMemberResponse) {};
+
+    // DeleteOrganizationMember removes a OrganizationMember from the Organization.
+    rpc DeleteOrganizationMember(DeleteOrganizationMemberRequest) returns (DeleteOrganizationMemberResponse) {};
+
+    // GetOrganizationSettings retrieves the settings of a Organization.
+    rpc GetOrganizationSettings(GetOrganizationSettingsRequest) returns (GetOrganizationSettingsResponse) {};
+
+    // UpdateOrganizationSettings updates the settings of a Organization.
+    rpc UpdateOrganizationSettings(UpdateOrganizationSettingsRequest) returns (UpdateOrganizationSettingsResponse) {};
+}
+
+message UpdateOrganizationRequest {
+    // organization_id is the ID of the organization to update the settings for.
+    string organization_id = 1;
+
+    // name is the new name of the organization
+    string name = 2;
+}
+
+message UpdateOrganizationResponse {
+}
+
+message UpdateOrganizationSettingsRequest {
+    // organization_id is the ID of the organization to update the settings for.
+    string organization_id = 1;
+
+    // settings are the settings to update
+    OrganizationSettings settings = 2;
+}
+
+message UpdateOrganizationSettingsResponse {
+}
+
+message GetOrganizationSettingsRequest {
+    // organization_id is the ID of the organization to retrieve the settings for.
+    string organization_id = 1;
+}
+
+message GetOrganizationSettingsResponse {
+    // settings are the settings of the organization
+    OrganizationSettings settings = 1;
+}
+
+message CreateOrganizationRequest {
+    // name is the organization name
+    string name = 1;
+}
+
+message CreateOrganizationResponse {
+    Organization organization = 1;
+}
+
+message GetOrganizationRequest {
+    // organization_id is the unique identifier of the Organization to retreive.
+    string organization_id = 1;
+}
+
+message GetOrganizationResponse {
+    Organization organization = 1;
+}
+
+message ListOrganizationsRequest {
+    PaginationRequest pagination = 1;
+}
+
+message ListOrganizationsResponse {
+    repeated Organization organizations = 1;
+    PaginationResponse pagination = 2;
+}
+
+message DeleteOrganizationRequest {
+    // organization_id is the ID of the organization to delete
+    string organization_id = 1;
+}
+
+message DeleteOrganizationResponse {
+}
+
+message GetOrganizationInvitationRequest {
+    string organization_id = 1;
+}
+
+message GetOrganizationInvitationResponse {
+    // invitation_id is the invitation ID for an Organization
+    string invitation_id = 1;
+}
+
+message JoinOrganizationRequest {
+    // invitation_id is the invitation ID for an Organization
+    string invitation_id = 1;
+}
+
+message JoinOrganizationResponse {
+    // organization_id is the id of the organization the user has just joined
+    string organization_id = 1;
+}
+
+message ResetOrganizationInvitationRequest {
+    string organization_id = 1;
+}
+
+message ResetOrganizationInvitationResponse {
+    // invitation_id is the new invitation id for the organization.
+    string invitation_id = 1;
+}
+
+message ListOrganizationMembersRequest {
+    // organization_id is the ID of the organization that contains the members to list
+    string organization_id = 1;
+    PaginationRequest pagination = 2;
+}
+
+message ListOrganizationMembersResponse {
+    // members are the organization members of this Organization
+    repeated OrganizationMember members = 1;
+    PaginationResponse pagination = 2;
+}
+
+message UpdateOrganizationMemberRequest {
+    // organization_id is the ID of the organization in which the role is to be updated
+    string organization_id = 1;
+
+    // user_id is the user for which the membership shall be updated.
+    string user_id = 2;
+
+    // role is the new role for the user in the organization
+    OrganizationRole role = 3;
+}
+
+message UpdateOrganizationMemberResponse {
+}
+
+message DeleteOrganizationMemberRequest {
+    // organization_id is the ID of the organization in which a member should be deleted.
+    string organization_id = 1;
+
+    // user_id is the ID of the user that should be deleted from the organization.
+    string user_id = 2;
+}
+
+message DeleteOrganizationMemberResponse {}

components/public-api/gitpod/experimental/v2/organization.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package gitpod.experimental.v2;
+
+option go_package = "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v2";
+
+message PaginationRequest {
+    // Page size is the maximum number of results to retrieve per page.
+    // Defaults to 25. Maximum 100.
+    int32 page_size = 1;
+
+    // Page is the page number of results to retrieve.
+    // The first page starts at 1.
+    // Defaults to 1.
+    int32 page = 2;
+}
+
+message PaginationResponse {
+    // Total is the total number of results available.
+    int32 total = 1;
+}