Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1275-removing-token-sets-sometimes-fails #1280

Merged
merged 3 commits into from
Sep 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/storage/GithubTokenStorage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
} from './GitTokenStorage';
import { SystemFilenames } from '@/constants/SystemFilenames';
import { ErrorMessages } from '@/constants/ErrorMessages';
import { joinPath } from '@/utils/string';

type ExtendedOctokitClient = Omit<Octokit, 'repos'> & {
repos: Octokit['repos'] & {
Expand Down Expand Up @@ -196,7 +197,7 @@ export class GithubTokenStorage extends GitTokenStorage {
let name = filePath.substring(this.path.length).replace(/^\/+/, '');
name = name.replace('.json', '');
const parsed = JSON.parse(decodeBase64(fileContent.data.content)) as GitMultiFileObject;
// @REAMDE we will need to ensure these reserved names
// @README we will need to ensure these reserved names

if (name === SystemFilenames.THEMES) {
return {
Expand Down Expand Up @@ -317,7 +318,7 @@ export class GithubTokenStorage extends GitTokenStorage {
(a.path && b.path) ? a.path.localeCompare(b.path) : 0
));

const filesToDelete = jsonFiles.filter((jsonFile) => !Object.keys(changeset).some((item) => jsonFile.path && item.endsWith(jsonFile?.path)))
const filesToDelete = jsonFiles.filter((jsonFile) => !Object.keys(changeset).some((item) => jsonFile.path && item === joinPath(this.path, jsonFile?.path)))
.map((fileToDelete) => (`${this.path.split('/')[0]}/${fileToDelete.path}` ?? ''));
return await this.createOrUpdate(changeset, message, branch, shouldCreateBranch, filesToDelete, true);
}
Expand Down
69 changes: 44 additions & 25 deletions src/storage/__tests__/GithubTokenStorage.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ describe('GithubTokenStorage', () => {
expect(await storageProvider.canWrite()).toBe(false);
});

it('canWrite should return false if not a collaborator', async () => {
it('canWrite should return false if the user is not a collaborator', async () => {
mockGetAuthenticated.mockImplementationOnce(() => (
Promise.resolve({
data: {
Expand All @@ -111,7 +111,7 @@ describe('GithubTokenStorage', () => {
});
});

it('canWrite should return false if it wasnt possible to fetch collaboration level', async () => {
it('canWrite should return false if it fails to fetch collaboration level', async () => {
mockGetAuthenticated.mockImplementationOnce(() => (
Promise.resolve({
data: {
Expand Down Expand Up @@ -260,7 +260,7 @@ describe('GithubTokenStorage', () => {
mockGetContent.mockClear();
});

it('can read from Git in a multifile format and return empty array when there is no content', async () => {
it('can read from Git in a multi file format and return empty array when there is no content', async () => {
mockGetContent.mockImplementation((opts: { path: string }) => {
if (opts.path === '') {
return Promise.resolve({
Expand Down Expand Up @@ -305,7 +305,7 @@ describe('GithubTokenStorage', () => {
mockGetContent.mockClear();
});

it('can read from Git in a multifile format when parent directory has multiple directory', async () => {
it('can read from Git in a multi file format when parent directory has multiple directory', async () => {
mockGetContent.mockImplementation((opts: { path: string }) => {
if (opts.path === '') {
return Promise.resolve({
Expand Down Expand Up @@ -403,7 +403,7 @@ describe('GithubTokenStorage', () => {
mockGetContent.mockClear();
});

it('can read from Git in a multifile format when parent directory has only one directory', async () => {
it('can read from Git in a multi file format when parent directory has only one directory', async () => {
mockGetContent.mockImplementation((opts: { path: string }) => {
if (opts.path === '') {
return Promise.resolve({
Expand Down Expand Up @@ -589,7 +589,7 @@ describe('GithubTokenStorage', () => {
});
});

it('should not be able to write a multifile structure when multifile flag is off', async () => {
it('should not be able to write a multi file structure when multi file flag is off', async () => {
mockCreateOrUpdateFiles.mockImplementationOnce(() => (
Promise.resolve({
data: {
Expand Down Expand Up @@ -622,7 +622,7 @@ describe('GithubTokenStorage', () => {
expect(mockCreateOrUpdateFiles).not.toHaveBeenCalled();
});

it('should be able to write a multifile structure', async () => {
it('should be able to write a multi file structure', async () => {
mockCreateOrUpdateFiles.mockImplementationOnce(() => (
Promise.resolve({
data: {
Expand Down Expand Up @@ -800,7 +800,7 @@ describe('GithubTokenStorage', () => {
});
});

it('should be able to rename and delete a multifile structure', async () => {
it('should be able to rename and delete a multi file structure', async () => {
mockGetContent.mockImplementation((opts: { path: string }) => {
if (opts.path === '') {
return Promise.resolve({
Expand All @@ -814,9 +814,9 @@ describe('GithubTokenStorage', () => {
return Promise.resolve({
data: [
{ path: 'data/$themes.json', sha: 'sha(data/$themes.json)', type: 'file' },
{ path: 'data/global.json', sha: 'sha(data/global.json)', type: 'file' },
{ path: 'data/core.json', sha: 'sha(data/core.json)', type: 'file' },
{ path: 'data/internal.json', sha: 'sha(data/internal.json)', type: 'file' },
{ path: 'data/colors/achieve.json', sha: 'sha(data/colors/achieve.json)', type: 'file' },
{ path: 'data/base/achieve.json', sha: 'sha(data/base/achieve.json)', type: 'file' },
{ path: 'data/achieve.json', sha: 'sha(data/achieve.json)', type: 'file' },
],
});
}
Expand All @@ -829,23 +829,23 @@ describe('GithubTokenStorage', () => {
});
}

if (opts.path === 'data/global.json') {
if (opts.path === 'data/colors/achieve.json') {
return Promise.resolve({
data: {
content: 'ewogICJyZWQiOiB7CiAgICAidHlwZSI6ICJjb2xvciIsCiAgICAibmFtZSI6ICJyZWQiLAogICAgInZhbHVlIjogIiNmZjAwMDAiCiAgfQp9',
},
});
}

if (opts.path === 'data/core.json') {
if (opts.path === 'data/base/achieve.json') {
return Promise.resolve({
data: {
content: 'ewogICJyZWQiOiB7CiAgICAidHlwZSI6ICJjb2xvciIsCiAgICAibmFtZSI6ICJyZWQiLAogICAgInZhbHVlIjogIiNmZjAwMDAiCiAgfQp9',
},
});
}

if (opts.path === 'data/internal.json') {
if (opts.path === 'data/achieve.json') {
return Promise.resolve({
data: {
content: 'ewogICJyZWQiOiB7CiAgICAidHlwZSI6ICJjb2xvciIsCiAgICAibmFtZSI6ICJyZWQiLAogICAgInZhbHVlIjogIiNmZjAwMDAiCiAgfQp9',
Expand Down Expand Up @@ -877,9 +877,9 @@ describe('GithubTokenStorage', () => {
sha: 'sha(data)',
tree: [
{ path: '$themes.json', type: 'blob', sha: 'sha($themes.json)' },
{ path: 'global.json', type: 'blob', sha: 'sha(global.json)' },
{ path: 'core.json', type: 'blob', sha: 'sha(core.json)' },
{ path: 'internal.json', type: 'blob', sha: 'sha(internal.json)' },
{ path: 'base/achieve.json', type: 'blob', sha: 'sha(base/achieve.json)' },
{ path: 'colors/achieve.json', type: 'blob', sha: 'sha(colors/achieve.json)' },
{ path: 'achieve.json', type: 'blob', sha: 'sha(achieve.json)' },
],
},
})
Expand Down Expand Up @@ -911,8 +911,8 @@ describe('GithubTokenStorage', () => {
},
{
type: 'tokenSet',
name: 'global',
path: 'global.json',
name: 'base/achieve',
path: 'base/achieve.json',
data: {
red: {
type: TokenTypes.COLOR,
Expand All @@ -923,8 +923,20 @@ describe('GithubTokenStorage', () => {
},
{
type: 'tokenSet',
name: 'core-rename',
path: 'core-rename.json',
name: 'achieve',
path: 'achieve.json',
data: {
red: {
type: TokenTypes.COLOR,
name: 'red',
value: '#ff0000',
},
},
},
{
type: 'tokenSet',
name: 'achieve-rename',
path: 'achieve-rename.json',
data: {
red: {
type: TokenTypes.COLOR,
Expand Down Expand Up @@ -956,22 +968,29 @@ describe('GithubTokenStorage', () => {
},
},
], null, 2),
'data/global.json': JSON.stringify({
'data/base/achieve.json': JSON.stringify({
red: {
type: TokenTypes.COLOR,
name: 'red',
value: '#ff0000',
},
}, null, 2),
'data/core-rename.json': JSON.stringify({
'data/achieve.json': JSON.stringify({
red: {
type: TokenTypes.COLOR,
name: 'red',
value: '#ff0000',
},
}, null, 2),
'data/achieve-rename.json': JSON.stringify({
red: {
type: TokenTypes.COLOR,
name: 'red',
value: '#ff0000',
},
}, null, 2),
},
filesToDelete: ['data/core.json', 'data/internal.json'],
filesToDelete: ['data/colors/achieve.json'],
ignoreDeletionFailures: true,

},
Expand All @@ -980,7 +999,7 @@ describe('GithubTokenStorage', () => {
mockGetContent.mockClear();
});

it('couldnt be able to rename and delete a multifile structure when there is no tree', async () => {
it('couldn\'t be able to rename and delete a multi file structure when there is no tree', async () => {
mockGetContent.mockImplementation((opts: { path: string }) => {
if (opts.path === '') {
return Promise.resolve({
Expand Down