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

[7.17] remove human-readable automatic slug generation (#132593) #133093

Merged
merged 1 commit into from
May 30, 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
6 changes: 0 additions & 6 deletions src/plugins/share/common/url_service/short_urls/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,6 @@ export interface ShortUrlCreateParams<P extends SerializableRecord> {
* URL. This part will be visible to the user, it can have user-friendly text.
*/
slug?: string;

/**
* Whether to generate a slug automatically. If `true`, the slug will be
* a human-readable text consisting of three worlds: "<adjective>-<adjective>-<noun>".
*/
humanReadableSlug?: boolean;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ export const registerCreateRoute = (router: IRouter, url: ServerUrlService) => {
minLength: 3,
maxLength: 255,
}),
/**
* @deprecated
*
* This field is deprecated as the API does not support automatic
* human-readable slug generation.
*
* @todo This field will be removed in a future version. It is left
* here for backwards compatibility.
*/
humanReadableSlug: schema.boolean({
defaultValue: false,
}),
Expand All @@ -35,7 +44,7 @@ export const registerCreateRoute = (router: IRouter, url: ServerUrlService) => {
router.handleLegacyErrors(async (ctx, req, res) => {
const savedObjects = ctx.core.savedObjects.client;
const shortUrls = url.shortUrls.get({ savedObjects });
const { locatorId, params, slug, humanReadableSlug } = req.body;
const { locatorId, params, slug } = req.body;
const locator = url.locators.get(locatorId);

if (!locator) {
Expand All @@ -52,7 +61,6 @@ export const registerCreateRoute = (router: IRouter, url: ServerUrlService) => {
locator,
params,
slug,
humanReadableSlug,
});

return res.ok({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,19 +127,6 @@ describe('ServerShortUrlClient', () => {
})
).rejects.toThrowError(new Error(`Slug "lala" already exists.`));
});

test('can automatically generate human-readable slug', async () => {
const { client, locator } = setup();
const shortUrl = await client.create({
locator,
humanReadableSlug: true,
params: {
url: '/app/test#foo/bar/baz',
},
});

expect(shortUrl.data.slug.split('-').length).toBe(3);
});
});

describe('.get()', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

import type { SerializableRecord } from '@kbn/utility-types';
import { SavedObjectReference } from 'kibana/server';
import { generateSlug } from 'random-word-slugs';
import { ShortUrlRecord } from '.';
import type {
IShortUrlClient,
Expand Down Expand Up @@ -59,14 +58,13 @@ export class ServerShortUrlClient implements IShortUrlClient {
locator,
params,
slug = '',
humanReadableSlug = false,
}: ShortUrlCreateParams<P>): Promise<ShortUrl<P>> {
if (slug) {
validateSlug(slug);
}

if (!slug) {
slug = humanReadableSlug ? generateSlug() : randomStr(4);
slug = randomStr(5);
}

const { storage, currentVersion } = this.dependencies;
Expand Down
16 changes: 0 additions & 16 deletions test/api_integration/apis/short_url/create_short_url/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,6 @@ export default function ({ getService }: FtrProviderContext) {
expect(response.body.url).to.be('');
});

it('can generate a human-readable slug, composed of three words', async () => {
const response = await supertest.post('/api/short_url').send({
locatorId: 'LEGACY_SHORT_URL_LOCATOR',
params: {},
humanReadableSlug: true,
});

expect(response.status).to.be(200);
expect(typeof response.body.slug).to.be('string');
const words = response.body.slug.split('-');
expect(words.length).to.be(3);
for (const word of words) {
expect(word.length > 0).to.be(true);
}
});

it('can create a short URL with custom slug', async () => {
const rnd = Math.round(Math.random() * 1e6) + 1;
const slug = 'test-slug-' + Date.now() + '-' + rnd;
Expand Down